/* Copyright (c) 2010 Vinay Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.gwt.maps.client.directions;

import java.util.List;

import com.google.gwt.maps.client.HasJso;

/**
 * The directions response retrieved from the directions server.
 * You can render these using a DirectionsRenderer or parse this object and
 * render it yourself. You must display the warnings and copyrights as noted in
 * the Maps API terms of service.
 * 
 * @author vinay.sekhri@gmail.com (Vinay Sekhri)
 */
public interface HasDirectionsResult extends HasJso {

  /**
   * An array of DirectionsRoutes, each of which contains information about the
   * legs and steps of which it is composed. There will only be one route unless
   * the DirectionsRequest was made with provideRouteAlternatives set to true.
   */
  public List<HasDirectionsRoute> getRoutes();
  
}
